home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 3 / Light ROM 3 - Disc 2.iso / programs / amiga / animfile / egsflick / readme < prev   
Text File  |  1993-11-19  |  11KB  |  247 lines
  1.  
  2.  
  3.         EGSFlick - play .FLI/.FLC animations on your EGS graphic board
  4.  
  5.                     By Frank Neumann, November 1993 
  6.                         Version 1.1a, 19.11.1993
  7.  
  8.                 Original source by Ron Schnell et al.
  9.  
  10. What's it ?
  11. -----------
  12. EGSFlick lets you play all of those nice .FLI/.FLC animations on your (EGS
  13. supporting) graphic board that you've seen so often in Pee-Cee computer
  14. shops demoing some strange VGA board.
  15. As well .FLI (fixed resolution of 320x200 pixels) as .FLC (free resolution)
  16. animation files are recognized and played.
  17. This program is a port of the X11 program 'xflick'. Great parts of the
  18. source have been taken over unmodified. The authors of this program so far
  19. were:
  20.     Ron Schnell (ronnie@sos.com)
  21.     Klaus Ehrenfried (klaus@spock.es.go.dlr.de)
  22.     Michael 'Papa' ;-) Pall (pall@rz.uni-karlsruhe.de)
  23.  
  24. Lots of thanks go to these guys for somehow making EGSFlick possible.
  25.  
  26. The original program was placed in the Public Domain, with the following
  27. conditions:
  28. ----- excerpt from original xflick.txt: -----
  29.         xflick - Ron Schnell, March, 1991
  30.     This code is provided as is, with no warrantees, expressed
  31.         or implied.  I believe this code to be free of encumbrance,
  32.         and offer it to the public domain.  I ask, however, that
  33.     this paragraph and my name be retained in any modified
  34.     versions of the file you may make, and that you notify me
  35.     of any improvements you make to the code.
  36.  
  37.     Ron Schnell (ronnie@sos.com)
  38. ----- end of excerpt -----
  39.  
  40. I think by porting xflick to EGS I have not hurt any of these conditions.
  41. I wanted to tell Ron Schnell about this port, but unfortunately there was
  42. no user 'ronnie' at 'sos.com' - probably he has left their house. Oh well.
  43.  
  44.  
  45. Requirements
  46. ------------
  47. EGSFlick will make no attempt to convert the .FLI/.FLC file into any other
  48. format than what it is supposed for: 8 bit, CLUT-based chunky pixel data.
  49. For that reason, you will need a graphic board that can produce such
  50. displays. Currently I know of the following that can do it for sure:
  51. ╖ Rainbow III
  52. ╖ Piccolo
  53. ╖ Spectrum
  54.  
  55. It should also work on a GVP EGS 110/24, but I haven't been able to test
  56. that. It would also work on other boards like the Picasso II if EGS were
  57. available for them :^).
  58.  
  59. EGSFlick opens a window on the EGS default screen. So you will need to set
  60. your EGS default screen to 8 bit before trying to run EGSFlick. Use the
  61. EGS preferences program 'EGS-ScreenMode' to do so.
  62.  
  63. Besides all this, you certainly need:
  64. ╖ AmigaDOS/Kickstart/Workbench 2.0 or above
  65. ╖ EGS (version 6 is ok but not required - I wrote this long before V6 or
  66.   any kind of multiple-device EGS was out)
  67. ╖ A graphic board capable of producing the above mentioned display
  68. ╖ FLI files to play. I have included a small one. I once found this
  69.   somewhere on a CD-Rom at my local PC shop, and liked it very much :-)
  70.  
  71.  
  72. Usage
  73. -----
  74. Usage: EGSFlick [-v] [-r<count>] [-d<delay>] [-n] fli_file
  75.  -v Verbose Debugging info
  76.  -r<count>  Repeat count times (0 = loop forever)
  77.  -d<delay>  Delay between frames in 1/70s
  78.  -n         Don't interpret file before display (slower but uses less memory)
  79.  
  80. Anything more to say ? Well, maybe this:
  81. On short anims, you can let EGSFlick unpack all images into memory and play
  82. them from there (provided you have enough RAM free) to gain maximum speed.
  83. With .FLCs or big .FLIs, however, it is recommended to use the -n switch.
  84. This will cause the pictures to be unpacked while the animation is playing,
  85. which saves a LOT of memory, but also slows down the replay speed.
  86.  
  87. To play an animation over and over, use the switch '-r0'.
  88.  
  89. Workbench usage ? Icons ? Sorry, not yet. I'm a shell enthusiast. Maybe, if
  90. many people ask for it. Tell me.
  91.  
  92. While EGSFlick is loading an animation, it displays the string 'Please wait
  93. while loading the animation' (clever, huh ? ;-) in the center of the window,
  94. and lists the individual frames of the anim in the title bar as they are
  95. parsed and unpacked. Once playing, the title bar shows the name of the
  96. animation.
  97.  
  98.  
  99. Keyboard control
  100. ----------------
  101. It's quite simple. Once the animation is running, you can press:
  102.  
  103. ╖ + to speed up the animation
  104. ╖ - to slow down the animation
  105. ╖ <Space> to pause and single-step
  106. ╖ c to continue after a pause/single step
  107. ╖ q to quit
  108.  
  109. If there are several open windows on the EGS default screen, activating
  110. another window will change the color map to what EGSFlick thinks is the
  111. 'original' colormap. This is a sort of 'private colormap', as seen under
  112. X11. When you re-activate the player window, the colors of the anim file
  113. are restored. To quit the program, use either 'q' or the close gadget at
  114. the upper left corner of the window.
  115.  
  116.  
  117. Notices
  118. -------
  119. EGSFlick is a nice program to demonstrate the speed of a Zorro III
  120. graphic board compared to a Zorro II board. I noticed this effect on a
  121. programmer's meeting in Germany in August '93 (thanks again, Ill). I got 
  122. a Piccolo board from the manufacturer to show it to those who were 
  123. interested. Well, when we arrived I just plugged the board into my A3k and 
  124. started the system. I checked out several programs on the Piccolo board, 
  125. and found that my EGSFlick was not playing as fast as I was used to from 
  126. my Rainbow III. The next day a collegue asked me, 'So, Franky, you DID set 
  127. the jumper on the board to Zorro III mode, didn't you ?' (Hi, Armin ! :-). 
  128. Ok, I didn't. I set the jumper, powered up, ran EGSFlick again, and 
  129. ZZzooommmm! There it was, the usual speed :-) 
  130. Try it yourself if you have a Piccolo and a Zorro III machine: Play an 
  131. animation at maximum speed (press the '-' key several times while the anim 
  132. is playing) with the jumper once set to 'Zorro II' and then set to 
  133. 'Zorro III'. I'm sure you WILL appreciate the difference between 
  134. 3 MBytes/sec and 9.4 MBytes/sec 8-).
  135.  
  136. Known bugs
  137. ----------
  138.  
  139. ╖ The 'private colormap' mechanism is just a simple hack. Whenever a running
  140. EGSFlick window receives an EI_iACTIVEWINDOW message, it activates its
  141. current colormap, and on the other hand when receiving an EI_iINACTIVEWINDOW
  142. message, it restores the colormap that it thinks was the original one.
  143. You can easily confuse EGSFlick by running two such processes simultaneously
  144. and quitting the one you started first. This isn't sure to show the problem,
  145. but it has done so sometimes. Don't expect anything like pen sharing. This
  146. program was written to be fast, not well-behaving.
  147.  
  148. ╖ The resolution of the delay is quite coarse. At the fastest rates you can
  149. just choose between '1/50th of a second between two pictures' and 'go as fast
  150. as you can'. Solution would be to go via the timer.device instead of
  151. dos.library/Delay. Currently I'm too lazy/busy to change this :-}
  152.  
  153. ╖ Originally the key to continue an animation was <Return>, not 'c'.
  154. Unfortunately I do not get an EI_iVANILLAKEY message when the <Return> key is
  155. pressed - Ulli believes EI_iRAWKEY should be ok for this. Well, I disagree.
  156. AmigaDOS windows _DO_ tell me about a VANILLAKEY message caused by pressing
  157. the <Return> key - although it is a 'non-printable' character..hint hint Ulli.
  158.  
  159. ╖ A damaged .FLI/.FLC file is not always recognized as such by the unpacker.
  160. You can be lucky and it tells you about problems and exits gracefully, but
  161. you might as well see the big Guru. Sorry, I didn't write that part of the
  162. code, and I won't go into debugging it.
  163.  
  164. ╖ I haven't yet found out how to clearly judge if the default screen is
  165. made up of planar or chunky pixels. For that reason, EGSFlick will try to
  166. run e.g. on a 'NTSC:High Res' screen with 8 bits depth (AGA for instance).
  167. However, this will most definitely crash your machine.
  168.  
  169.  
  170. ToDo
  171. ----
  172.  
  173. ╖ Support for Workbench start with a nice icon, tooltypes etc.
  174. ╖ [...]
  175.  
  176.  
  177. History
  178. -------
  179. The first version of this program was hacked together in two days, just
  180. before the CeBIT'93 in Hanover at the end of March. I wanted to get this
  181. done very quickly to have something for a friend who showed the Rainbow III
  182. graphic board there. I think he liked it.
  183. After that, I almost forgot about this program. Now I saw this new upload in
  184. the AmiNet - some other .fli player - and thought I should make EGSFlick
  185. ready for release. There is as of now so few PD/Freeware EGS software out,
  186. maybe this will encourage some people to go ahead and release what they
  187. have written and not yet 'published', too.
  188.  
  189. Version 1.1 (14.11.1993) : 
  190.     First released version
  191.  
  192. Version 1.1a (19.11.1993):
  193.     Removed an E_PIXELMAP check from eflick.c - the program did not run on a
  194.     Spectrum board. I still need to learn a lot about EGS and its
  195.     bitmaps/types.
  196.  
  197. Author
  198. ------
  199.  
  200. I'm a student of computer science at the University of Oldenburg, Germany
  201. (well, at least I pretend to be one ;-). Hum...what else should I write
  202. here ? Oh well - if you like and use this program, I'm definitely interested
  203. in hearing about that! Let's just declare this whole package to be 'EGSware',
  204. ok ? That means: If you like&use EGSFlick and have written some nice
  205. program(s) for EGS, send it to me. Alternatively, I will not reject any
  206. presents like nice POV-Ray pictures or scenes, self-made .FLIs, money,
  207. chocolate, post cards or whatever. Send what you like :-)
  208.  
  209.  
  210. Shameless plug
  211. --------------
  212. POV-Ray addict ? Check out ftp.informatik.uni-oldenburg.de:/pub/dkbtrace
  213. (soon to be /pub/pov-ray) :-)
  214.  
  215.  
  216. Contents of this archive
  217. ------------------------
  218.  
  219. This archive should only be distributed in its unmodified form, consisting
  220. of these files:
  221. EGSFlick/EGSFlick           - the player binary
  222. EGSFlick/EGSFlick.doc       - this document
  223. EGSFlick/EGSFlick.doc.info  - no, I won't explain what this is
  224. EGSFlick/warbeat.fli        - a demo .FLI file, 320x200, 16 frames
  225. EGSFlick/eflick.c           - main part, argument parser, all EGS specific
  226.                               stuff
  227. EGSFlick/read.c             - file parser & unpacker
  228. EGSFlick/eflick.h           - header file, structure definitions etc.
  229. EGSFlick/Makefile           - yep, a Makefile.
  230. EGSFlick.info               - You know. Yes, you really do.
  231.  
  232. The program has been compiled under Dice 2.07.56R, but it should also be easy
  233. to build it under SAS. And no, no DMakefile ist included. I love gnu-make.
  234. If you don't have it, get it NOW ! :-)
  235.  
  236.  
  237. Final words
  238. -----------
  239. Quoting Fred Fish: Have fun !
  240.  
  241. Greetings, questions, bug reports and donations should be sent to:
  242. + Frank Neumann, Hauptstr. 107, 26131 Oldenburg   The Amiga still is it. +
  243. +     InterNet: Frank.Neumann@informatik.uni-oldenburg.de IRC:Franky     +
  244. + UUCP:neumann@uniol.uucp InHouse:amigo@faramir Z-Netz:Neumann@uniol.zer +
  245. + "All die Manta-Computer-User - Hauptsache vorne leuchtet 33Mhz auf..." +
  246. +        - Stefan Schulze in fido.ger.amiga, 04.08.1992                  +
  247.